This endpoint will provide you with a comprehensive overview of backlinks and related data for a bulk of up to 1000 pages, domains, or subdomains. If you indicate a single page as a target, you will get comprehensive summary data on all backlinks for that page.
Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard
# Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
login="login"
password="password"
cred="$(printf ${login}:${password} | base64)"
curl --location --request POST "https://api.dataforseo.com/v3/backlinks/bulk_pages_summary/live"
--header "Authorization: Basic ${cred}"
--header "Content-Type: application/json"
--data-raw "[
{
"targets": [
"https://dataforseo.com/solutions",
"https://dataforseo.com/about-us"
]
}
]"
<?php
// You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforseo.com/';
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
$client = new RestClient($api_url, null, 'login', 'password');
$post_array = array();
// simple way to set a task
$post_array[] = array(
"targets" => [
"https://dataforseo.com/",
"https://dataforseo.com/about-us"
]
);
try {
// POST /v3/backlinks/bulk_pages_summary/live
$result = $client->post('/v3/backlinks/bulk_pages_summary/live', $post_array);
print_r($result);
// do something with post result
} catch (RestClientException $e) {
echo "\n";
print "HTTP code: {$e->getHttpCode()}\n";
print "Error code: {$e->getCode()}\n";
print "Message: {$e->getMessage()}\n";
print $e->getTraceAsString();
echo "\n";
}
$client = null;
?>
from client import RestClient
# You can download this file from here https://cdn.dataforseo.com/v3/examples/python/python_Client.zip
client = RestClient("login", "password")
post_data = dict()
# simple way to set a task
post_data[len(post_data)] = dict(
targets=[
"https://dataforseo.com/",
"https://dataforseo.com/about-us"
]
)
# POST /v3/backlinks/bulk_pages_summary/live
response = client.post("/v3/backlinks/bulk_pages_summary/live", post_data)
# you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if response["status_code"] == 20000:
print(response)
# do something with result
else:
print("error. Code: %d Message: %s" % (response["status_code"], response["status_message"]))
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://api.dataforseo.com/v3/backlinks/bulk_pages_summary/live',
'headers': {
'Content-Type': 'application/json',
'Authorization': 'Basic c3VwcG9ydEBkYXRhZm9yc2VvLmNvbTpTUnJYVHp2UGtFSjgzdXlz'
},
body: JSON.stringify([
{
"targets": [
"https://dataforseo.com/solutions",
"https://dataforseo.com/about-us"
]
}
])
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
namespace DataForSeoDemos
{
public static partial class Demos
{
public static async Task backlinks_bulk_pages_summary_live()
{
var httpClient = new HttpClient
{
BaseAddress = new Uri("https://api.dataforseo.com/"),
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
DefaultRequestHeaders = { Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(Encoding.ASCII.GetBytes("login:password"))) }
};
var postData = new List<object>();
postData.Add(new
{
targets = new[]
{
"https://dataforseo.com/",
"https://dataforseo.com/about-us"
}
});
// POST /v3/backlinks/bulk_pages_summary/live
// the full list of possible parameters is available in documentation
var taskPostResponse = await httpClient.PostAsync("/v3/backlinks/bulk_pages_summary/live", new StringContent(JsonConvert.SerializeObject(postData)));
var result = JsonConvert.DeserializeObject<dynamic>(await taskPostResponse.Content.ReadAsStringAsync());
// you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if (result.status_code == 20000)
{
// do something with result
Console.WriteLine(result);
}
else
Console.WriteLine($"error. Code: {result.status_code} Message: {result.status_message}");
}
}
}
The above command returns JSON structured like this:
All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array.
Description of the fields for setting a task:
Field name
Type
Description
targets
array
domains, subdomains or webpages to get summary data for required field
a domain or a subdomain should be specified without https:// and www.
a page should be specified with absolute URL (including http:// or https://)
you can specify up to 1000 pages, domains, or subdomains in each request. note that the URLs you set in a single request cannot belong to more than 100 different domains.
include_subdomains
boolean
indicates if the subdomains of the target will be included in the search
optional field
if set to false, the subdomains will be ignored
default value: true
tag
string
user-defined task identifier
optional field the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
Description of the fields in the results array:
Field name
Type
Description
version
string
the current version of the API
status_code
integer
general status code
you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
status_message
string
general informational message
you can find the full list of general informational messages here
time
string
execution time, seconds
cost
float
total tasks cost, USD
tasks_count
integer
the number of tasks in the tasks array
tasks_error
integer
the number of tasks in the tasks array returned with an error
tasks
array
array of tasks
id
string
task identifier unique task identifier in our system in the UUID format
status_code
integer
status code of the task
generated by DataForSEO; can be within the following range: 10000-60000
you can find the full list of the response codes here
status_message
string
informational message of the task
you can find the full list of general informational messages here
time
string
execution time, seconds
cost
float
cost of the task, USD
result_count
integer
number of elements in the result array
path
array
URL path
data
object
contains the same parameters that you specified in the POST request
result
array
array of results
total_count
integer
total number of relevant items in the database
items_count
integer
number of items in the results array
items
array
items array
type
string
type of element = ‘backlinks_page_summary’
url
string
page URL
rank
integer
page rank
rank of the page on the target website rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm
learn more about the metric and how it is calculated in this help center article
main_domain_rank
integer
rank of the main domain
rank of the main domain is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm
learn more about the metric and how it is calculated in this help center article
backlinks
integer
number of backlinks
first_seen
string
date and time when our crawler found a backlink to this page for the first time
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example: 2019-11-15 12:57:46 +00:00
lost_date
string
date and time when the last backlink to this page was lost
indicates the date and time when our crawler visited the page and it responded with 4xx or 5xx status code or the last backlink was removed
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example: 2017-01-24 13:20:59 +00:00
backlinks_spam_score
integer
average spam score of the backlinks pointing to the page
learn more about how the metric is calculated on this help center page
broken_backlinks
integer
number of broken backlinks
number of broken backlinks pointing to the page
broken_pages
integer
number of broken pages
number of pages that respond with 4xx or 5xx status codes where backlinks are pointing to
referring_domains
integer
indicates the number domains referring to the page
referring_domains_nofollow
integer
number of domains pointing at least one nofollow link to the target
referring_main_domains
integer
indicates the number of referring main domains
referring_main_domains_nofollow
integer
number of main domains pointing at least one nofollow link to the target
referring_ips
integer
number of referring IP addresses
number of IP addresses pointing to this page
referring_subnets
integer
number of referring subnetworks
referring_pages
integer
indicates the number of pages pointing to the relevant url
referring_pages_nofollow
integer
number of referring pages pointing at least one nofollow link to the target
referring_links_tld
object
top-level domains of the referring links
contains top level domains and referring link count per each
referring_links_types
object
types of referring links
indicates the types of the referring links and link count per each type
possible values: anchor, image, link, meta, canonical, alternate, redirect
referring_links_attributes
object
link attributes of the referring links
indicates link attributes of the referring links and link count per each attribute
referring_links_platform_types
object
types of referring platforms
indicates referring platform types and and link count per each platform
referring_links_semantic_locations
object
semantic locations of the referring links
indicates semantic elements in HTML where the referring links are located and link count per each semantic location
you can get the full list of semantic elements here
examples: article, section, footer
referring_links_countries
object
ISO country codes of the referring links
indicates ISO country codes of the domains where the referring links are located and the link count per each country